home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / golf / gms.zip / GMSUTIL.DOC < prev    next >
Text File  |  1988-05-19  |  16KB  |  379 lines
  1. GMSUTIL.DOC
  2.  
  3. GMSUTIL - MEAN 18 Golf Management System Utility  Release 1.0
  4.  
  5. COPYRIGHT Dan Moore 1988
  6.  
  7. GMSUTIL and its companion programs are Shareware.  If you
  8. find the m useful, consider sending the author a
  9. contribution. for further information, please refer to the
  10. LICENSE.DOC file contained in the GMS ARChive.
  11.  
  12.  
  13. WHAT IS GMSUTIL?
  14.  
  15. GMSUTIL is a DOS/PKARC/PKXARC shell intended specifically
  16. for the management of Accolade's MEAN 18 course files (.M18
  17. files).  GMSUTIL allows easy migration of course files from
  18. ARChived to active status -- courses must be active to be
  19. played --.  ARChived courses generally occupy 74% less
  20. space than their active counterparts.  Given a course file
  21. size of 110K, and the very large number of courses
  22. available (over 300 at the time of this writing), MEAN 18
  23. addicts could very easily have well over 30 megabytes of
  24. expensive hard disk space dedicated to the storage of
  25. course files.  GMSUTIL does not solve the problem, but it
  26. sure helps minimize it.
  27.  
  28.  
  29. REQUIREMENTS
  30.  
  31. As is the case with GMS, the GMSUTIL program must reside in
  32. your MEAN 18 directory (along with MEAN 18 programs and
  33. course files, of course).  Two other files, GMSSTAT.SCR and
  34. GMSHELP.SCR, must also be in that directory for GMSUTIL to
  35. function properly.  Last, Phil Katz's excellent PKARC and
  36. PKXARC programs must either be in the MEAN 18 directory or
  37. in your DOS PATH.  If you don't know what a DOS PATH is,
  38. then read about it in your DOS manual, or copy the programs
  39. into your MEAN 18 Directory and forget about PATHs
  40. altogether.
  41.  
  42. GMSUTIL (as well as GMS) supports course files with the
  43. .M18 and .M10 extensions, as is the case with the M18Vxx
  44. program.  All active courses are stored with a .M10 suffix.
  45. GMS changes the suffix to M18 prior to invoking the MEAN 18
  46. game itself (GOLF.EXE) and GMSUTIL does this prior to
  47. invoking the course architect module (ARCH.EXE).
  48.  
  49. There must be at least ONE active or ARChived course file
  50. in your MEAN 18 directory.  If no such files are found,
  51. GMSUTIL has nothing to work with and will terminate with an
  52. appropriate message.
  53.  
  54. NOTE:  Please support Phil Katz's PKARC utilities by
  55. sending in the modest contribution he suggests.  It is his
  56. program, not GMSUTIL, that is saving you all the expensive
  57. HD space space.  GMSUTIL merely saves time and adds
  58. convenience.
  59.  
  60.  
  61. THE GMSARC UTILITY
  62.  
  63. GMSARC is intended as a one-time helper to GMSUTIL.  If you
  64. already have a large number of MEAN 18 course files in your
  65. MEAN 18 HD subdirectory, manual ARChiving of these files
  66. one at a time, even with the help of GMSUTIL, can be a
  67. lengthy process.  GMSARC will ARChive ALL your course files
  68. (after renaming them all to the .M10 suffix) and will
  69. DELETE the original .M10 file after the ARChiving is
  70. completed.
  71.  
  72. However, before you run GMSARC, run the GMSUTIL program at
  73. least once to see how much space is used by your course
  74. files (the F8 key in GMSUTIL will display disk space
  75. statistics).   THEN run GMSARC and witness the savings.  To
  76. run GMSARC, make sure the program is in your MEAN 18
  77. directory and type GMSARC <Enter> at the DOS prompt.
  78.  
  79. NOTE: Although GMSARC has been tested thoroughly, something
  80. can always go wrong....I strongly recommend that you backup
  81. your MEAN 18 course files before you start.  I did, and I
  82. wrote this sucker.
  83.  
  84. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++GMSUTIL OPERATION
  85.  
  86. NOTE: The "User's Manual" portion of this document if
  87.       formatted so as to make the search for specific
  88.       topics easier (ie, with Vern Buerg's excellent LIST
  89.       program).  The operations manual starts with a line
  90.       of "+" characters.  Major function areas are
  91.       delimited with lines of "=" characters, and each
  92.       command is delimited with a line of dashes ("-").
  93.       Title/Subtitles are right-aligned to make spotting
  94.       and identification easier and faster.  Because of the
  95.       intuitive nature of the program and its permanent
  96.       function menus, online help has not been provided.
  97.  
  98. ==========================================================STARTING THE PROGRAM
  99.  
  100. Start GMSUTIL by issuing the GMSUTIL command at the DOS
  101. prompt (I don't; I use the excellent Automenu program to
  102. manage all my executable files -- Automenu is also a
  103. shareware product).  The program will load and immediately
  104. read and sort the course/arc file directory.  The standard
  105. GMSUTIL screen will be displayed.
  106.  
  107. The GMSUTIL screen is laid out simply and logically.   The
  108. left half (the blue half) of the screen  contains the
  109. course file directory and function reminder windows.  The
  110. right half (the green half) contains the ARChive  file
  111. directory and function reminder windows.  The last 5 lines
  112. of the screen contain the global function help window,
  113. displayed in dark gray over light gray.
  114.  
  115.  
  116. ===============================================================GLOBAL FUNCTIONS
  117.  
  118. As their name indicates, "Global" functions are available at all
  119. times.
  120.  
  121. ---------------------------------------------COURSE / ARCHIVE WINDOW NAVIGATION
  122.  
  123. At any time, the Up/Dn/PgUp/PgDn keys will move the course
  124. or ARChive selection cursor through the active directory
  125. window.  The selected file name will be displayed appear in
  126. high-intensity white over a lighter-colored background.
  127. Function keys F1 through F7 affect ONLY the selected file
  128. name.
  129.  
  130. --------------------------------------------------TAB KEY: SWITCH ACTIVE WINDOW
  131.  
  132. The TAB key (-->|, usually to the immediate left of the "Q"
  133. key), switches from course functions to archive functions.
  134. Press it a few times and notice the active function
  135. indicator bar (the top screen line) switch from the course
  136. windows to the archive windows.  Function keys F1 through
  137. F7, when depressed, will perform the correponding active
  138. window's function.
  139.  
  140. ---------------------------------------------------------------Alt-R: DOS Shell
  141.  
  142. The Alt-R key combination will exit GMSUTIL and will invoke
  143. a new copy of COMMAND.COM.  The screen will be cleared and
  144. a message will be displayed to remind you to type "EXIT" to
  145. return to GMSUTIL.  This "DOS Shell" function allowsx you
  146. to invoke any standard DOS commands (ie, dir, copy, or any
  147. legitimate program or .BAT file).  Since GMSUTIL AND
  148. another copy of COMMAND.COM are in memory, you may be
  149. limited as to the size of the program you may run.  Most
  150. DOS commands should run satisfactorily, however.  Once you
  151. no longer need DOS services, type the word EXIT at the DOS
  152. prompt, press <Enter>, and you will be returned to GMSUTIL.
  153.  
  154. -------------------------------------------F8 KEY: HARD DISK STATISTICS DISPLAY
  155.  
  156. The F8 key, when pressed, will cause a hard disk space
  157. summary window to be displayed in the middle of the screen
  158. (in the same, unexciting color scheme as the global
  159. function window).
  160.  
  161. The HD summary windows shows the following information:
  162.  
  163. o Current drive address
  164. o Total capacity of current drive (in Kbytes)
  165. o Total free space available on current drive
  166. o Free space as a percentage of total drive capacity
  167. o Number of active course files and their space requirement
  168. o Number of ARChive courses and their space requirement
  169. o An estimate of the space that can be saved by ARChiving
  170.   active course files (expressed in Kb and as a percent of
  171.   total capacity).  PKARC yields an average 74% savings.
  172.  
  173. Pressing the <Escape> key clears the statistics window and
  174. restores the screen to its previous status.
  175.  
  176. ---------------------------------------------------F9 KEY: GO PLAY MEAN 18 GOLF
  177.  
  178. The F9 Key will immediately terminate GMSUTIL and transfer
  179. control to the GMS program.  Documentation for GMS is
  180. contained in a separate .DOC file
  181.  
  182. ----------------------------------------------------------F10 KEY: QUIT GMSUTIL
  183.  
  184. Pressing the F10 key will immediately terminate GMSUTIL and
  185. return control to DOS.
  186.  
  187.  
  188. ========================================================= COURSE FILE FUNCTIONS
  189.  
  190. -------------------------------------------F1 KEY: ARCHIVE AND KEEP COURSE FILE
  191.  
  192. The F1 key invokes the PKARC utility to ARChive the
  193. selected course file.  The screen will be cleared, and
  194. control will be passed to the PKARC utility.  Once PKARC
  195. terminates, the screen will be restored to its prior status
  196. (the ARChive directory window will be updated to show the
  197. new ARChive, however).  The original course file will be
  198. left untouched.  The F8 statistics display will reflect the
  199. increase in space utilization.
  200.  
  201. -----------------------------------------F2 KEY: ARCHIVE AND DELETE COURSE FILE
  202.  
  203. The F2 key duplicates the function of the F1 key.  Once the
  204. course file is ARChived, the scren will be restored and a
  205. file deletion prompt will be displayed in a RED window in
  206. the middle of the screen.  Pressing the "Y" key will cause
  207. the course file to be deleted; pressing <Esc> will cancel
  208. the delete operation and restore the screen.  The course
  209. directory window will be updated to reflect the file
  210. deletion.  The F8 display will reflect the change in space
  211. utilization. 
  212.  
  213. NOTE: This function will yield maximum hard disk space
  214.       savings.
  215.  
  216. -----------------------------------------------------F3 KEY: IMPORT COURSE FILE
  217.  
  218. The F3 key will allow importing a course file from
  219. diskette.  The course file MUST have a .M18 or .M10
  220. extension.  A prompt window will be displayed, asking you
  221. to insert the source diskette in drive A:.  Do so and press
  222. <Enter>, or press <Esc> to cancel the import request.
  223.  
  224. GMSUTIL will then read the diskette directory and display a
  225. window containing the names of the .M1x files on the
  226. diskette.  To import a course file, move the cursor to the
  227. desired file name and press <Enter>.  The file will be
  228. copied, the course directory will be updated, and the
  229. diskette window will be redisplayed to allow you to import
  230. additional course files.  You may press <Esc> at any time
  231. to return to the standard GMSUTIL screen.
  232.  
  233.  
  234. NOTE: release 1.0 of GMSUTIL does NOT check for free space
  235.       availability on the hard disk prior to a course file
  236.       import.  You may wish to insure that you have
  237.       sufficient space by checking the HD statistics (F8).
  238.  
  239. -----------------------------------------------------F4 KEY: EXPORT COURSE FILE
  240.  
  241. The F4 key will cause the selected course file to be
  242. exported to the diskette in drive A:.  As with the import
  243. function, a prompt window will ask for a diskette to be
  244. inserted.  Pressing <Enter> proceeds with the export; <Esc>
  245. cancels the operation.
  246.  
  247. NOTE: release 1.0 of GMSUTIL does not check for space
  248.       availability on the target diskette in an export
  249.       operation.
  250.  
  251. -----------------------------------------------F5 KEY: COPY/RENAME COURSE FILE
  252.  
  253. The F5 key will create a duplicate of the selected course
  254. file under a new name for which you will be prompted.
  255. GMSUTIL only requires the NAME of the file; the .M10
  256. extension will be automatically appended.  A second prompt
  257. will request confirmation.  Pressing "Y" proceeds with the
  258. operation; <Esc> cancels the operation, and "N" allows you
  259. to specify a different name for the duplicate file.
  260. Creating a copy of an existing course under a new name may
  261. be a wise thing to do prior to invoking the course
  262. architect; it insures preservation of the original course
  263. file under its original name.
  264.  
  265. -----------------------------------------------------F6 KEY: DELETE COURSE FILE
  266.  
  267. The F6 key will cause deletion of the selected course file.
  268. A prompt will request confirmation of the deletion.
  269. Pressing "Y" will cause the file to be deleted; <Esc>
  270. will cancel the request.
  271.  
  272. -------------------------------------------------------F7 KEY: COURSE ARCHITECT
  273.  
  274. The F7 Key will activate the currently selected course and
  275. pass control to the MEAN 18 Couse Architect program.  The
  276. selected course will be the only course displayed on the
  277. architect selection menu.  Upon exit from the architect
  278. program, control will return to the GMSUTIL program and the
  279. screen will be restored to its prior status.
  280.  
  281. =========================================================ARCHIVE FILE FUNCTIONS
  282.  
  283. --------------------------------------F1 KEY: UNARCHIVE COURSE AND KEEP ARCHIVE
  284.  
  285. The F1 function will immediately unARChive the currently
  286. selected ARChive file.  The screen will be cleared and
  287. control will be passed to the PKXARC program.  Upon
  288. completion, the active course directory window will be
  289. updated to reflect the presence of the new course.
  290.  
  291. GMSUTIL will successfully unARC multiple-course ARChives.
  292.  
  293. NOTE: this function will yield the largest increase in
  294.       space utilization (similar to the F1 course file
  295.       function).
  296.  
  297. ------------------------------------F2 KEY: UNARCHIVE COURSE AND DELETE ARCHIVE
  298.  
  299. This function will immediately unARChive the currently
  300. selected ACRhive file.  Upon completion, a file deletion
  301. prompt will be displayed.  This function's operation is
  302. identical to the course file F2 function.
  303.  
  304. ---------------------------------------------------------F3 KEY: IMPORT ARCHIVE
  305.  
  306. Except for the .ARC file extension, this function is
  307. identical to the course file F3 function.
  308.  
  309. NOTE:  Multiple-Course ARChives may be imported into
  310.        GMSUTIL, then may be unARCed to yield multiple
  311.        additional course files.  GMSUTIL, however, cannot
  312.        create multiple-course ARChives.
  313.  
  314. ---------------------------------------------------------F4 KEY: EXPORT ARCHIVE
  315.  
  316. Except for the .ARC file extension, this function is
  317. identical to the course file export function.
  318.  
  319. ---------------------------------------------------------F5 KEY: RENAME ARCHIVE
  320.  
  321. This functions allows the renaming of an ARChive file.  I
  322. have absolutely no idea why anyone would ever want to use
  323. it.  Its main reason for existence is that I wanted
  324. geometric balance between the two screen halves.
  325.  
  326. ---------------------------------------------------------F6 KEY: DELETE ARCHIVE
  327.  
  328. Except for the .ARC file extension, this function is
  329. identical to the course file F6 function.
  330.  
  331. --------------------------------------------------F7 KEY: VIEW ARCHIVE CONTENTS
  332.  
  333. This function will invoke the PKXARC program to display the
  334. contents of an ARChive.  Although one should know what's in
  335. a single-course ARChive, some ARChives may not contain what
  336. they're supposed to, or may be corrupted.
  337.  
  338. +++++++++++++++++++++++++++++++++++++++++++++++++END OF OPERATIONS INSTRUCTIONS
  339.  
  340.  
  341. TECHNICAL DEPARTMENT
  342.  
  343. GMSUTIL was written entirely in Microsoft QuickBasic
  344. release 3.0.  Extensive use was made of Hamerly Computer
  345. Services' ProBas library of routines for QuickBasic.
  346. ProBas was used for screen display/windowing, directory
  347. access, and disk statistics.  The .SCR files were created
  348. with PC Magazine's PAINT program, which helps design color
  349. text screens and stores tham as binary files which are
  350. easily loaded and displayed using ProBas routines.  GMSUTIL
  351. contains approximately 1150 lines of source code.
  352.  
  353. The program was developed and tested on an AT-compatible
  354. computer with 640K of memory, running under IBM PC-DOS
  355. release 3.3.  GMSUTIL was tested successfully on four
  356. other AT-compatible machines and one true blue original IBM
  357. PC.  AT-compatible units used Phoenix, DTK, and Award BIOS.
  358. The program was tested on CGA and EGA-compatible color
  359. displays.  Hard disks used include Seagate, Miniscribe, and
  360. Priam.
  361.  
  362.  
  363.  
  364.  
  365. Dan Moore
  366. 1514 South Drive
  367. Columbus, IN 47203
  368.  
  369.  
  370. MEAN 18 is a trademark of Micromint and Accolade, Inc.
  371. IBM, PC, AT are trademarks of International Business Machines
  372. PKARC/PKXARC are trademarks and copyrighted Phil Katz
  373. CGA and EGA are trademarks of IBM
  374. IBM is a trademark of International Business Machines
  375. Phoenix, DTK, AWARD are trademark of whoever owns them.
  376.  
  377.  
  378. ############################################################ END OF GMSUTIL.DOC
  379.